package com.wltjack.sysmanage.config;

import com.github.xiaoymin.swaggerbootstrapui.annotations.EnableSwaggerBootstrapUI;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

/**
 * @ClassName SwaggerAutoConfiguration
 * @Description swgger配置类
 * @Author kangliang
 * @Date 2021/03/01 13:05
 * @Version 1.0
 */
@Configuration
@EnableSwagger2
@EnableSwaggerBootstrapUI
public class SwaggerAutoConfiguration {
    //是否开启swagger，正式环境一般是需要关闭的
    @Value("${swagger.enabled}")
    private boolean enableSwagger;

    /**
     * 功能描述: 创建API应用
     * @return: Docket
     * @Author: kangliang
     * @Date: 2021-03-01 13:13
     */
    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                // apiInfo() -> 增加api相关信息
                .apiInfo(apiInfo())
                //是否开启 (true 开启  false隐藏。生产环境建议隐藏)
                .enable(enableSwagger)
                // 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现
                .select()
                //扫描的路径包,设置basePackage会将包下的所有被@Api标记类的所有方法作为api
                .apis(RequestHandlerSelectors.any())
                //指定路径处理PathSelectors.any()代表所有的路径
                .paths(PathSelectors.any())
                .build();
    }

    /**
     * 功能描述: 创建该API的基本信息（这些基本信息会展现在文档页面中）
     * <p></p>
     * 访问地址：http://项目实际地址/doc.html
     * @return: ApiInfo
     * @Author: kangliang
     * @Date: 2021-03-01 13:14
     */
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder().title("华西项目")
                .description("华西项目-api文档")
                .termsOfServiceUrl("")
                .version("1.0").build();
    }

}
